home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / actvp232.zip / ACTVIEW.DOC next >
Text File  |  1992-08-21  |  15KB  |  321 lines
  1.  ---------------------------------------------------------------------------
  2.                              ACTVIEW PCB 2.32 (c)
  3.                      PCBoard Activity Log Viewer/Analyzer
  4.                        Copyright (c) 1992 by Greg Wilson
  5.                              All Rights Reserved
  6.                                    08/19/92
  7.                              Author: Greg Wilson
  8.  ---------------------------------------------------------------------------
  9.  
  10.                                    Purpose
  11.                                    -------
  12.  Actview was written out of my own need for a tool to assist with reading the
  13.  activity log of my BBS. The task of viewing the log with a file viewer was
  14.  taking too long and I found myself rushing through the process, missing many
  15.  important events such as invalid password attempts, carrier drops, new users,
  16.  etc..
  17.  
  18.  Actview was originally written for Wildcat BBS's but after the fantastic
  19.  response I received from Sysops, I decided to write a version for PCBoard as
  20.  well!
  21.  
  22.                                  Instructions
  23.                                  ------------
  24.  For a quick look at what Actview has to offer, copy ACTVIEW.EXE to the
  25.  directory containing your CALLER file(s) and run it. If you have more than
  26.  one node or use a different naming convention, you will have to build a file
  27.  named ACTVIEW.CFG (see below). The program will display the last recorded
  28.  day's activity in a one line per call format with the critical information
  29.  shown. At the top of the screen, the range of dates in the log is displayed
  30.  along with the date of the information being displayed. The primary Fkey
  31.  functions are displayed at the bottom of the screen. More functions are shown
  32.  in the help window (F1). The calls can be scrolled using the arrows, home,
  33.  end, page up, and page down keys. If enter is pressed, the detail of the
  34.  highlighted call is extracted from the activity log and displayed. Important
  35.  events such as invalid logon attempts, file overwrites, etc., are
  36.  highlighted.
  37.  
  38.  
  39.  Key     Function
  40.  ------------------------------------------------------------------------
  41.  F1    - Displays the help window.
  42.  F2    - Swaps to another node's log. Directories to your different logs must
  43.          be entered in a file named ACTVIEW.CFG (see below).
  44.  F3    - Displays the following activity:
  45.          * Invalid logon attempts.
  46.          * Invalid Passwords.
  47.          * BBS errors
  48.          To return to the normal display, hit escape.
  49.  F4    - Displays totals for the currently displayed date.
  50.  F5    - Displays new users for the displayed day.
  51.          To return to the normal display, hit escape.
  52.  F6    - Allows jumping directly to any date in the activity log.
  53.  F7    - Jumps to the previous day's activity.
  54.  F8    - Jumps to the next day's activity.
  55.  
  56.  F9    - Displays all calls of a specified user. The program will prompt for
  57.          user name, beginning date, and ending date of search. The name will
  58.          default to the highlighted call. The dates will default to the
  59.          beginning and end of the activity log. Actview will scan the log
  60.          finding all matching calls and then display the calls in the usual
  61.          one line per call format. To view totals for the user, hit F4. To
  62.          return to the normal display, hit Escape. To abort the search, press
  63.          the space bar.
  64.  F10/ ALT-X / ESC - Quit Actview.
  65.  ALT-F - Display the ACTVIEW.FLG file (see below)
  66.  ALT-L - Toggles local calls. Local calls will not be displayed or
  67.          included in the daily counts.
  68.  ALT-S - Allows the entire activity log to be searched for a given string
  69.          (such as filename, Message#, ..etc.). Here are some ways I use this
  70.          feature:
  71.          * Search for all activity related to a particular file.
  72.          * Search for all activity related to a bulletin or door.
  73.          * Find all users that still use XMODEM.
  74.          * See who is using QMAIL.
  75.          * See who has exceeded their time limit.
  76.          * ...etc.!
  77.  ALT-D - View all downloads for the day.
  78.  ALT-U - View all uploads for the day.
  79.  ALT-O - Sort calls. Actview will display a menu of 7 different sort types.
  80.  ALT-V - View all activity logs for all nodes. Every log in the ACTVIEW.CFG
  81.          file is scanned for the currently displayed date and the calls are
  82.          loaded. This is a major time saver!
  83.  
  84.  
  85.  
  86.  A typical Actview session would go something like:
  87.  
  88.       * Type ACTVIEW (if multinode, use parameter VIRTUAL to load all nodes)
  89.       * Hit F3; if any errors are displayed, view the detail.
  90.       * Hit F5; view new users.
  91.       * Hit ALT-U to see what was uploaded.
  92.       * Hit ALT-D to see what was downloaded.
  93.       * Hit ESC to go back to viewing all calls.
  94.       * Scroll though the summary looking for uploads, msgs, carrier
  95.         drops and pages viewing the detail of these activities if desired.
  96.  
  97.  An average review takes me about 3 minutes compared to 30 minutes before
  98.  I had ACTVIEW!
  99.  
  100.                               User Defined Flags
  101.                               ------------------
  102.  
  103.  Actview allows sysops to define flags to indicate that a certain activity has
  104.  occurred during a call. These one character flags are displayed on the initial
  105.  call summary screen and are defined in the file ACTVIEW.FLG. This has many
  106.  uses including:
  107.  
  108.                 * Flag all users that download a certain file
  109.                 * Flag all users that use a certain door
  110.                 * Flag all users that drop carrier
  111.                 * Flag all users that join a certain conference
  112.                 * .. etc.
  113.  
  114.  A flag is a single character to be displayed in the flag column on the
  115.  summary screen. Up to 5 flags can be displayed for a single call. If more
  116.  than 5 flags are found, the last flag will be then character "*". In the
  117.  ACTVIEW.FLG file, the first column contains the flag character to be
  118.  displayed. The string to turn on the flag is enclosed in quotes on the same
  119.  line as the flag character.
  120.  
  121.  Example: If an additional flag was desired to show any activity related to
  122.  the file "ACTVIEW.ZIP", ACTVIEW.FLG would be updated as follows (remember
  123.  that the flag characters must be in column 1):
  124.  
  125.                               C "CARRIER LOST"
  126.                               C "LINK LOST"
  127.                               N "NEW EXTUSER"
  128.                               A "ACCESS DENIED"
  129.                               P "PASSWORD FAILURE"
  130.                               S "ATTEMPTED TO LOGON AS"
  131.                               V "ACTVIEW.ZIP"
  132.  
  133.                      ***    Note: Case is ignored    ***
  134.  
  135.  See the file ACTVIEW.FLG for more examples. The initial flags for dropping
  136.  carrier, errors, new users, and exceeding download ratio are already set up.
  137.  
  138.  
  139.                              Multi Node Features
  140.                              -------------------
  141.  
  142.  For multi-node operation, create a file named ACTVIEW.CFG with the
  143.  directories and filenames in the following format: (in column 1)
  144.  
  145.                        C:\PCB\CALLER1
  146.                        C:\PCB\CALLER2
  147.                        C:\PCB\CALLER3
  148.                        C:\PCB\CALLER4
  149.  
  150.  The entire path *and* filename must be specified in each line.
  151.  
  152.  NOTE: ACTVIEW.CFG must be in the same directory as ACTVIEW.EXE
  153.  
  154.  This feature may also be useful for single node sysops that maintain backup
  155.  copies of their logs under other names and/or directories and still want to
  156.  access them via Actview.
  157.  
  158.  
  159.  
  160.                               Actview parameters
  161.                               ------------------
  162.  
  163.           ACTVIEW mm/dd/yy NOLocal ERRors NEW NODE=x MONO SNOW BIOS
  164.  
  165.             mm/dd/yy - Go directly to mm/dd/yy
  166.             HELP     - Display help screen
  167.             NOLocal  - Do not show local calls (ALT-L toggles)
  168.             ERRors   - Show logon errors for the day (F3 toggles)
  169.             NEW      - Show new users only (F5 toggles)
  170.             NODE=x   - Go to node x. ACTVIEW.CFG must be present.
  171.             MONO     - Force monochrome attributes
  172.             NOMOUSE  - Turn Off Mouse support (speeds up entry and exit).
  173.             SNOW     - Turn on snow checking during screen writes
  174.             VIRT     - View all nodes at once.
  175.             BIOS     - Use bios screen writes. This option is not necessary
  176.                        when running Actview under Desqview because checks for
  177.                        Desqview are made and direct screen writes are remapped
  178.                        accordingly. BIOS writes are much slower than the
  179.                        normal direct screen writes and should not be used.
  180.             LARGE    - Use large jump values during searches. This parameter
  181.                        is normally not needed unless some of the calls in the
  182.                        activity logs exceed 100 lines (usually netmail hubs).
  183.                        If Actview sometimes hangs, try this parameter. It is
  184.                        not the size of the actual activity log file but the
  185.                        size of the individual calls within the log.
  186.                        >> This parameter should no longer be needed <<
  187.             25       - Set 25 line mode
  188.             43       - Set 43 line mode (EGA)
  189.             50       - Set 50 line mode (VGA)
  190.  
  191.  
  192.                            Requirements and Limits
  193.                            -----------------------
  194.  * ACTVIEW is Desqview aware. No extra parameters are needed for Desqview as
  195.    Actview detects DV automatically.
  196.  
  197.  
  198.                       Memory requirements: 220k (Multi node see note)
  199.                  Max nodes in ACTVIEW.CFG: 100
  200.                                 Max flags: 100
  201.  
  202.   Max number of displayed calls is now only limited by the available memory.
  203.   The max number is displayed in the help window. This is also the max number
  204.   of hits when searching (ALT-S or F9). If the search finds more than the
  205.   available number of displayed calls, a message will be displayed and the
  206.   search will be halted.
  207.  
  208.   Multi-node note: If your BBS receives a lot of calls each day, more memory
  209.   will be needed to view the calls. With 200k, only about 400 calls per day
  210.   are allowed to be viewed at once. The max number of calls is displayed in
  211.   the help window.
  212.  
  213.  * Actview opens the CALLER files in shared READ ONLY mode. *No* writes are
  214.    made to any files.
  215.  
  216.  
  217.                                   Liability
  218.                                   ---------
  219.  
  220.  Actview has been tested on multiple machines using many different
  221.  configurations and no problems have occurred. However, if a problem does
  222.  arise due to Actview, I cannot be held responsible. Use at your own risk.
  223.  
  224.  
  225.                         Distribution and Registration
  226.                         -----------------------------
  227.  
  228.  Actview may be freely distributed only as the following unaltered files:
  229.  
  230.                                  ACTVIEW.EXE
  231.                                  ACTVIEW.FLG
  232.                                  ACTVIEW.DOC
  233.                                  ACTVIEW.HIS
  234.                                  READ.ME
  235.                                  REGISTER.DOC
  236.  
  237.  ACTVIEW is  not free. You must register after the 30-day evaluation time
  238.  period.
  239.  
  240.  ACTVIEW is a Shareware product.  It is distributed through public access
  241.  channels so that perspective buyers can have the opportunity to evaluate the
  242.  product before making a  decision to buy. If you decide to use this software,
  243.  then you are under both legal and moral obligation to register it with the
  244.  author. But if you decide not to use it after evaluating the software, you
  245.  are under no obligation. It is fully protected by State, Federal and
  246.  International copyright laws.
  247.  
  248.  If you continue to use ACTVIEW after the 30-day evaluation time period you
  249.  must register it.
  250.  
  251.                             Registration Fee  : $25 US
  252.  
  253.  Why Register?
  254.  --------------------------------------------------------------------
  255.  * All opening and closing screens are removed!
  256.  * Registered users have access to the Actview support BBS is granted!
  257.  * All Actview reports can be downloaded from the support BBS!
  258.  * All future updates are free!
  259.  
  260.  To register ACTVIEW, complete in the order form (REGISTER.DOC) and mail along
  261.  with your check or money order payable to "Greg Wilson" to:
  262.  
  263.  
  264.                           ==========================
  265.                           >>    After 06/05/92    <<
  266.                           ==========================
  267.                                  Greg Wilson
  268.                            1252 Fordham Drive #101
  269.                           Glendale Heights, Il 60139
  270.  
  271.                               BBS: 708-752-4303
  272.  
  273.  
  274.  
  275.  ██████████████████████████████████████████████████████████████████████████████
  276.                 * Credit Card Orders (VISA/MC/Discover/Amex) *
  277.  ██████████████████████████████████████████████████████████████████████████████
  278.  
  279.          Visa/MC/Amex/Discover (via the Public Software Library):
  280.  
  281.                         1-800-2424-PSL or 713-524-6394
  282.                         FAX: 1-713-524-6398
  283.                         CIS Email: 71355,470
  284.  
  285.                               Product #10408
  286.  
  287.                     Credit card Price is $25 + $3 handling
  288.  
  289.                       THESE NUMBERS ARE FOR ORDERS ONLY!
  290.  
  291.                Do not call these numbers for technical support!
  292.  
  293.       All orders are relayed back to me the same day the order is made.
  294.  
  295.     The registered version can be shipped, uploaded or downloaded from my
  296.                             BBS or via CompuServe.
  297.  
  298.  ██████████████████████████████████████████████████████████████████████████████
  299.  
  300.  
  301.  
  302.  
  303.                             Contacting the Author
  304.                             ---------------------
  305.  
  306.  I can be reached for comments, questions, suggestions, complaints, etc., at
  307.  the following EMAIL boxes:
  308.  
  309.  
  310.            My BBS            (SYSOP)            - mail checked daily
  311.            Salt Air          (GREG WILSON)      - Main Conference Only Daily
  312.            CompuServe        (76547,3106)       - mail checked daily
  313.            EXEC-PC           (GREGORY WILSON)   - mail checked daily
  314.            Channel 1         (GREG WILSON)      - mail checked daily
  315.            PC-Ohio           (GREG WILSON)      - mail checked daily
  316.            Executive Network (GREG WILSON)      - mail checked daily
  317.  
  318.  
  319.  
  320.                                     -end-
  321.